Skip to content

doc(RDKit): add Size parameter document #5064

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Jan 8, 2025
Merged

doc(RDKit): add Size parameter document #5064

merged 5 commits into from
Jan 8, 2025
+13 −3

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 8, 2025 •
edited by sourcery-ai bot
Loading

add Size parameter document

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符；如果有关联 Issue 请在下方填写相关编号

Description

fixes #5063

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Add documentation for the Size parameter in the RDKit component.

New Features:

  • Add support for specifying the width and height of the RDKit component using the Width and Height parameters.

Documentation:

  • Document the Size parameter of the RDKit component.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 8, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request adds documentation for the Size parameter in the RDKit component and introduces new Width and Height properties to control the size of the rendered molecule.

Class diagram showing updated RDKit component with size parameters

classDiagram
    class RDKit {
        +string Value
        +int Width
        +int Height
        +Render()
    }
    note for RDKit "New Width and Height properties
control molecule rendering size"
Loading

File-Level Changes

Change Details Files
Added a new demo for the RDKit component showcasing the usage of the Size parameter.
  • Added a new demo block to the RDKits.razor file to demonstrate the Width and Height properties.
  • Included examples of how to set the Width and Height properties to control the size of the rendered molecule within the new demo block.
 src/BootstrapBlazor.Server/Components/Samples/RDKits.razor
Updated project file and locale files.
  • Modified the project file (BootstrapBlazor.Server.csproj) to include the changes related to the RDKit component.
  • Updated locale files (en-US.json and zh-CN.json) with new entries for the demo and parameters descriptions.
 src/BootstrapBlazor.Server/BootstrapBlazor.Server.csproj
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json

Assessment against linked issues

Issue Objective Addressed Explanation
#5063 Add sample code for RDKit component demonstrating Size parameter ✅
#5063 Document the Size parameter for the RDKit component ✅
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added the documentation Improvements or additions to documentation label Jan 8, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 8, 2025
sourcery-ai[bot]
sourcery-ai bot previously approved these changes Jan 8, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please include the changes made to the localization files (en-US.json and zh-CN.json) in the PR.
  • The PR template is incomplete. Please fill out the Risk assessment justification and provide more details about issue #5063 in the description.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ArgoZhang @densen2014
Merge branch 'main' into doc-RDKit
002a10c 
# Conflicts:
#	src/BootstrapBlazor.Server/BootstrapBlazor.Server.csproj
#	src/BootstrapBlazor.Server/Components/Samples/RDKits.razor
#	src/BootstrapBlazor.Server/Locales/en-US.json
#	src/BootstrapBlazor.Server/Locales/zh-CN.json

Co-Authored-By: Alex chow <[email protected]>
@ArgoZhang ArgoZhang dismissed sourcery-ai[bot]’s stale review January 8, 2025 06:49

The merge-base changed after approval.

@ArgoZhang ArgoZhang enabled auto-merge (squash) January 8, 2025 06:50
@ArgoZhang ArgoZhang disabled auto-merge January 8, 2025 06:50
@ArgoZhang ArgoZhang enabled auto-merge (squash) January 8, 2025 06:50
@codecov
Copy link

codecov bot commented Jan 8, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (e4c37db) to head (002a10c).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff            @@
##              main     #5064   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          631       631           
  Lines        27969     27969           
  Branches      4010      4010           
=========================================
  Hits         27969     27969

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ArgoZhang
Copy link
Member Author

ArgoZhang commented Jan 8, 2025

@sourcery-ai review

sourcery-ai[bot]
sourcery-ai bot approved these changes Jan 8, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please include the changes to the localization strings (en-US.json and zh-CN.json) in the PR diff for review.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ArgoZhang ArgoZhang merged commit d5a6e70 into main Jan 8, 2025
6 checks passed
@ArgoZhang ArgoZhang deleted the doc-RDKit branch January 8, 2025 06:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] approved these changes

Assignees

@ArgoZhang ArgoZhang

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

v9.2.0

Development

Successfully merging this pull request may close these issues.

doc(RDKit): add Size parameter document

2 participants

@ArgoZhang